<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9"/>
<title>NGUI: UIToggle Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">NGUI
   &#160;<span id="projectnumber">3.11.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Packages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('class_u_i_toggle.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_u_i_toggle-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">UIToggle Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Simple toggle functionality.  
 <a href="class_u_i_toggle.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for UIToggle:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_u_i_toggle.png" usemap="#UIToggle_map" alt=""/>
  <map id="UIToggle_map" name="UIToggle_map">
<area href="class_u_i_widget_container.html" title="Widget container is a generic type class that acts like a non-resizeable widget when selecting things..." alt="UIWidgetContainer" shape="rect" coords="0,56,116,80"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a59cd27f30e7ca8ba910db35d48713271"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59cd27f30e7ca8ba910db35d48713271"></a>
delegate bool&#160;</td><td class="memItemRight" valign="bottom"><b>Validate</b> (bool choice)</td></tr>
<tr class="separator:a59cd27f30e7ca8ba910db35d48713271"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2ee93df87afb7057e676b2e79bc5c1a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_toggle.html#ab2ee93df87afb7057e676b2e79bc5c1a">Start</a> ()</td></tr>
<tr class="memdesc:ab2ee93df87afb7057e676b2e79bc5c1a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Activate the initial state.  <a href="#ab2ee93df87afb7057e676b2e79bc5c1a">More...</a><br /></td></tr>
<tr class="separator:ab2ee93df87afb7057e676b2e79bc5c1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc903d23f56c075db86a772fb148f9ea"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_toggle.html#acc903d23f56c075db86a772fb148f9ea">Set</a> (bool state, bool notify=true)</td></tr>
<tr class="memdesc:acc903d23f56c075db86a772fb148f9ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fade out or fade in the active sprite and notify the OnChange event listener. If setting the initial value, call <a class="el" href="class_u_i_toggle.html#ab2ee93df87afb7057e676b2e79bc5c1a" title="Activate the initial state. ">Start()</a> first.  <a href="#acc903d23f56c075db86a772fb148f9ea">More...</a><br /></td></tr>
<tr class="separator:acc903d23f56c075db86a772fb148f9ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ac7a5e41adbd13a4ebe4b1dd554cb03a6"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_u_i_toggle.html">UIToggle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_toggle.html#ac7a5e41adbd13a4ebe4b1dd554cb03a6">GetActiveToggle</a> (int <a class="el" href="class_u_i_toggle.html#a11cfdeec745a2cb123488c4423b5ae22">group</a>)</td></tr>
<tr class="memdesc:ac7a5e41adbd13a4ebe4b1dd554cb03a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the first active toggle within the specified group.  <a href="#ac7a5e41adbd13a4ebe4b1dd554cb03a6">More...</a><br /></td></tr>
<tr class="separator:ac7a5e41adbd13a4ebe4b1dd554cb03a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a11cfdeec745a2cb123488c4423b5ae22"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_toggle.html#a11cfdeec745a2cb123488c4423b5ae22">group</a> = 0</td></tr>
<tr class="memdesc:a11cfdeec745a2cb123488c4423b5ae22"><td class="mdescLeft">&#160;</td><td class="mdescRight">If set to anything other than '0', all active toggles in this group will behave as radio buttons.  <a href="#a11cfdeec745a2cb123488c4423b5ae22">More...</a><br /></td></tr>
<tr class="separator:a11cfdeec745a2cb123488c4423b5ae22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1bd77338f627e2d4f06271f58178ae7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_u_i_widget.html">UIWidget</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_toggle.html#af1bd77338f627e2d4f06271f58178ae7">activeSprite</a></td></tr>
<tr class="memdesc:af1bd77338f627e2d4f06271f58178ae7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sprite that's visible when the 'isActive' status is 'true'.  <a href="#af1bd77338f627e2d4f06271f58178ae7">More...</a><br /></td></tr>
<tr class="separator:af1bd77338f627e2d4f06271f58178ae7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abce2e44cca1ed46a5d40b7154842b865"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_toggle.html#abce2e44cca1ed46a5d40b7154842b865">invertSpriteState</a> = false</td></tr>
<tr class="memdesc:abce2e44cca1ed46a5d40b7154842b865"><td class="mdescLeft">&#160;</td><td class="mdescRight">If 'true', when checked the sprite will be hidden when the toggle is checked instead of when it's not.  <a href="#abce2e44cca1ed46a5d40b7154842b865">More...</a><br /></td></tr>
<tr class="separator:abce2e44cca1ed46a5d40b7154842b865"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adadaf66343dcc4a437be56c02a48000f"><td class="memItemLeft" align="right" valign="top">Animation&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_toggle.html#adadaf66343dcc4a437be56c02a48000f">activeAnimation</a></td></tr>
<tr class="memdesc:adadaf66343dcc4a437be56c02a48000f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Animation to play on the active sprite, if any.  <a href="#adadaf66343dcc4a437be56c02a48000f">More...</a><br /></td></tr>
<tr class="separator:adadaf66343dcc4a437be56c02a48000f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aded82863d998e1901d49e200b01bb5b2"><td class="memItemLeft" align="right" valign="top">Animator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_toggle.html#aded82863d998e1901d49e200b01bb5b2">animator</a></td></tr>
<tr class="memdesc:aded82863d998e1901d49e200b01bb5b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Animation to play on the active sprite, if any.  <a href="#aded82863d998e1901d49e200b01bb5b2">More...</a><br /></td></tr>
<tr class="separator:aded82863d998e1901d49e200b01bb5b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5e39c8c575a72f56f3872ad2f859019"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_u_i_tweener.html">UITweener</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_toggle.html#af5e39c8c575a72f56f3872ad2f859019">tween</a></td></tr>
<tr class="memdesc:af5e39c8c575a72f56f3872ad2f859019"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tween to use, if any.  <a href="#af5e39c8c575a72f56f3872ad2f859019">More...</a><br /></td></tr>
<tr class="separator:af5e39c8c575a72f56f3872ad2f859019"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2add5824dfa06ff8e0dbfa80c4e1b884"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_toggle.html#a2add5824dfa06ff8e0dbfa80c4e1b884">startsActive</a> = false</td></tr>
<tr class="memdesc:a2add5824dfa06ff8e0dbfa80c4e1b884"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the toggle starts checked.  <a href="#a2add5824dfa06ff8e0dbfa80c4e1b884">More...</a><br /></td></tr>
<tr class="separator:a2add5824dfa06ff8e0dbfa80c4e1b884"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a98e735163a796af2577b57d55858be"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_toggle.html#a8a98e735163a796af2577b57d55858be">instantTween</a> = false</td></tr>
<tr class="memdesc:a8a98e735163a796af2577b57d55858be"><td class="mdescLeft">&#160;</td><td class="mdescRight">If checked, tween-based transition will be instant instead.  <a href="#a8a98e735163a796af2577b57d55858be">More...</a><br /></td></tr>
<tr class="separator:a8a98e735163a796af2577b57d55858be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acab8b1d04ff9834035b4beb39d5c3205"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_toggle.html#acab8b1d04ff9834035b4beb39d5c3205">optionCanBeNone</a> = false</td></tr>
<tr class="memdesc:acab8b1d04ff9834035b4beb39d5c3205"><td class="mdescLeft">&#160;</td><td class="mdescRight">Can the radio button option be 'none'?  <a href="#acab8b1d04ff9834035b4beb39d5c3205">More...</a><br /></td></tr>
<tr class="separator:acab8b1d04ff9834035b4beb39d5c3205"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf8d808fa2a0470361975255d1554394"><td class="memItemLeft" align="right" valign="top">List&lt; <a class="el" href="class_event_delegate.html">EventDelegate</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_toggle.html#adf8d808fa2a0470361975255d1554394">onChange</a> = new List&lt;<a class="el" href="class_event_delegate.html">EventDelegate</a>&gt;()</td></tr>
<tr class="memdesc:adf8d808fa2a0470361975255d1554394"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callbacks triggered when the toggle's state changes.  <a href="#adf8d808fa2a0470361975255d1554394">More...</a><br /></td></tr>
<tr class="separator:adf8d808fa2a0470361975255d1554394"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7006863a56d55b8c4027063a31a7dcf3"><td class="memItemLeft" align="right" valign="top">Validate&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_toggle.html#a7006863a56d55b8c4027063a31a7dcf3">validator</a></td></tr>
<tr class="memdesc:a7006863a56d55b8c4027063a31a7dcf3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Want to validate the choice before committing the changes? Set this delegate.  <a href="#a7006863a56d55b8c4027063a31a7dcf3">More...</a><br /></td></tr>
<tr class="separator:a7006863a56d55b8c4027063a31a7dcf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a34d3a62c62c019f25512f7bc1001d92b"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_better_list.html">BetterList</a>&lt; <a class="el" href="class_u_i_toggle.html">UIToggle</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_toggle.html#a34d3a62c62c019f25512f7bc1001d92b">list</a> = new <a class="el" href="class_better_list.html">BetterList</a>&lt;<a class="el" href="class_u_i_toggle.html">UIToggle</a>&gt;()</td></tr>
<tr class="memdesc:a34d3a62c62c019f25512f7bc1001d92b"><td class="mdescLeft">&#160;</td><td class="mdescRight">List of all the active toggles currently in the scene.  <a href="#a34d3a62c62c019f25512f7bc1001d92b">More...</a><br /></td></tr>
<tr class="separator:a34d3a62c62c019f25512f7bc1001d92b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac079555474bd6a6ad536cfb9b66d8ce9"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_u_i_toggle.html">UIToggle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_toggle.html#ac079555474bd6a6ad536cfb9b66d8ce9">current</a></td></tr>
<tr class="memdesc:ac079555474bd6a6ad536cfb9b66d8ce9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current toggle that sent a state change notification.  <a href="#ac079555474bd6a6ad536cfb9b66d8ce9">More...</a><br /></td></tr>
<tr class="separator:ac079555474bd6a6ad536cfb9b66d8ce9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a584c421de142dda89bb91cbf15af4f07"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_toggle.html#a584c421de142dda89bb91cbf15af4f07">value</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a584c421de142dda89bb91cbf15af4f07"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the toggle is checked.  <a href="#a584c421de142dda89bb91cbf15af4f07">More...</a><br /></td></tr>
<tr class="separator:a584c421de142dda89bb91cbf15af4f07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a831f64b509dda0b5928eabdb51b0e2cc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_toggle.html#a831f64b509dda0b5928eabdb51b0e2cc">isColliderEnabled</a><code> [get]</code></td></tr>
<tr class="memdesc:a831f64b509dda0b5928eabdb51b0e2cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the collider is enabled and the widget can be interacted with.  <a href="#a831f64b509dda0b5928eabdb51b0e2cc">More...</a><br /></td></tr>
<tr class="separator:a831f64b509dda0b5928eabdb51b0e2cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf7260de28a613896cf319ed5832e811"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acf7260de28a613896cf319ed5832e811"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>isChecked</b><code> [get, set]</code></td></tr>
<tr class="separator:acf7260de28a613896cf319ed5832e811"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Simple toggle functionality. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ac7a5e41adbd13a4ebe4b1dd554cb03a6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="class_u_i_toggle.html">UIToggle</a> UIToggle.GetActiveToggle </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>group</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Return the first active toggle within the specified group. </p>

</div>
</div>
<a class="anchor" id="acc903d23f56c075db86a772fb148f9ea"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void UIToggle.Set </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>state</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>notify</em> = <code>true</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Fade out or fade in the active sprite and notify the OnChange event listener. If setting the initial value, call <a class="el" href="class_u_i_toggle.html#ab2ee93df87afb7057e676b2e79bc5c1a" title="Activate the initial state. ">Start()</a> first. </p>

</div>
</div>
<a class="anchor" id="ab2ee93df87afb7057e676b2e79bc5c1a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void UIToggle.Start </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Activate the initial state. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="adadaf66343dcc4a437be56c02a48000f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Animation UIToggle.activeAnimation</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Animation to play on the active sprite, if any. </p>

</div>
</div>
<a class="anchor" id="af1bd77338f627e2d4f06271f58178ae7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_u_i_widget.html">UIWidget</a> UIToggle.activeSprite</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sprite that's visible when the 'isActive' status is 'true'. </p>

</div>
</div>
<a class="anchor" id="aded82863d998e1901d49e200b01bb5b2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Animator UIToggle.animator</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Animation to play on the active sprite, if any. </p>

</div>
</div>
<a class="anchor" id="ac079555474bd6a6ad536cfb9b66d8ce9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_u_i_toggle.html">UIToggle</a> UIToggle.current</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Current toggle that sent a state change notification. </p>

</div>
</div>
<a class="anchor" id="a11cfdeec745a2cb123488c4423b5ae22"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int UIToggle.group = 0</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>If set to anything other than '0', all active toggles in this group will behave as radio buttons. </p>

</div>
</div>
<a class="anchor" id="a8a98e735163a796af2577b57d55858be"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool UIToggle.instantTween = false</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>If checked, tween-based transition will be instant instead. </p>

</div>
</div>
<a class="anchor" id="abce2e44cca1ed46a5d40b7154842b865"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool UIToggle.invertSpriteState = false</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>If 'true', when checked the sprite will be hidden when the toggle is checked instead of when it's not. </p>

</div>
</div>
<a class="anchor" id="a34d3a62c62c019f25512f7bc1001d92b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_better_list.html">BetterList</a>&lt;<a class="el" href="class_u_i_toggle.html">UIToggle</a>&gt; UIToggle.list = new <a class="el" href="class_better_list.html">BetterList</a>&lt;<a class="el" href="class_u_i_toggle.html">UIToggle</a>&gt;()</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>List of all the active toggles currently in the scene. </p>

</div>
</div>
<a class="anchor" id="adf8d808fa2a0470361975255d1554394"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">List&lt;<a class="el" href="class_event_delegate.html">EventDelegate</a>&gt; UIToggle.onChange = new List&lt;<a class="el" href="class_event_delegate.html">EventDelegate</a>&gt;()</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Callbacks triggered when the toggle's state changes. </p>

</div>
</div>
<a class="anchor" id="acab8b1d04ff9834035b4beb39d5c3205"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool UIToggle.optionCanBeNone = false</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Can the radio button option be 'none'? </p>

</div>
</div>
<a class="anchor" id="a2add5824dfa06ff8e0dbfa80c4e1b884"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool UIToggle.startsActive = false</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Whether the toggle starts checked. </p>

</div>
</div>
<a class="anchor" id="af5e39c8c575a72f56f3872ad2f859019"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_u_i_tweener.html">UITweener</a> UIToggle.tween</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Tween to use, if any. </p>

</div>
</div>
<a class="anchor" id="a7006863a56d55b8c4027063a31a7dcf3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Validate UIToggle.validator</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Want to validate the choice before committing the changes? Set this delegate. </p>

</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a831f64b509dda0b5928eabdb51b0e2cc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool UIToggle.isColliderEnabled</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Whether the collider is enabled and the widget can be interacted with. </p>

</div>
</div>
<a class="anchor" id="a584c421de142dda89bb91cbf15af4f07"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool UIToggle.value</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Whether the toggle is checked. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>D:/WorkDir/Unity3D_Work/taidou_arpg/Assets/NGUI/Scripts/Interaction/UIToggle.cs</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_u_i_toggle.html">UIToggle</a></li>
    <li class="footer">Generated on Sat Jan 4 2020 22:30:28 for NGUI by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9 </li>
  </ul>
</div>
</body>
</html>
